home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 10 / AACD 10.iso / CDTools / MUIRexx / MCC_Icon / Developer / Autodocs / MCC_Icon.doc
Text File  |  1996-09-05  |  4KB  |  159 lines
  1. TABLE OF CONTENTS
  2.  
  3. Icon/--announce--
  4. Icon/--background--
  5. Icon/--history--
  6. Icon/MUIA_Icon_Name
  7. Icon/MUIA_Icon_DefaultTool
  8. Icon/--announce--
  9.  
  10.    TITLE
  11.     Icon.mcc
  12.  
  13.    VERSION
  14.     1.1
  15.  
  16.    RELEASE DATE
  17.     04.09.1996
  18.  
  19.    AUTHOR
  20.     Russell Leighton (russ@sneezy.lancaster.ca.us)
  21.  
  22.    DESCRIPTION
  23.     Icon is a Custom Class of the Magic User Interface © by
  24.     Stefan Stuntz.    It's a subclass of area-class.
  25.  
  26.     MUI public custom class which allows use of an icon's render and select
  27.     images for display in a gadget.  Depending on the gadget's select state
  28.     the appropriate image will be displayed.
  29.  
  30.    SPECIAL REQUIREMENTS
  31.     MUI >= 3.2
  32.  
  33.    AVAILABILITY
  34.     ftp://wuarchive.wustl.edu/pub/aminet/dev/mui/MCC_Icon_1_1.lha
  35.     And all other Aminet sites.
  36.  
  37.    PRICE
  38.     Free
  39.  
  40.    DISTRIBUTION
  41.     You can copy and distribute this source code as long as you do not
  42.     take more than $5 for one disk or $40 for one CD!
  43. Icon/--background--
  44.  
  45.    NAME
  46.     Icon -- ... (V36)
  47.  
  48.    FUNCTION
  49.     MUI public custom class which allows use of an icon's render and select
  50.     images for display in a gadget.  Depending on the gadget's select state
  51.     the appropriate image will be displayed.
  52.  
  53.    NOTES
  54.     None at the moment.
  55.  
  56.    COPYRIGHT
  57.     This software is copyright 1996 by Russell Leighton.
  58.     All rights reserved!
  59.  
  60.    DISCLAIMER
  61.     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  62.     APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  63.     HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
  64.     WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  65.     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  66.     A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
  67.     PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
  68.     DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
  69.     CORRECTION.
  70.  
  71.     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  72.     WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE
  73.     THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
  74.     INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
  75.     ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING
  76.     BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
  77.     LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
  78.     TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  79.     PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  80.  
  81.     THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
  82.     UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  83.  
  84.    DISTRIBUTION
  85.     Permission for COMMERCIAL USE is only given by specific
  86.     consent from the author.
  87.  
  88.     Permission is hereby granted, without written agreement and without
  89.     license, to USE this software and its documentation for any
  90.     NON-COMMERCIAL purpose, provided that the above copyright notice
  91.     and paragraphs appear in all copies of this software.
  92.  
  93.    AUTHOR
  94.     Russell Leighton
  95.  
  96.     EMail: russ@sneezy.lancaster.ca.us
  97. Icon/--history--
  98.  
  99.    NAME
  100.     history -- Development history of the Icon MUI custom class
  101.  
  102.     v1.0    8/8/96 -    Initial release
  103.     v1.1    9/4/96 -    Added MUIA_Version and MUIA_Revision
  104.                         Fixed docs to reflect proper acknowledgement of
  105.                         original documentation - sorry Kai :-(
  106.  
  107.    VERSION
  108.     $VER: Icon 1.1 (04.09.96)
  109. Icon/MUIA_Icon_Name
  110.  
  111.    NAME
  112.     MUIA_Icon_Name, STRPTR [I..] -- ... (V1)
  113.  
  114.    SYNOPSIS
  115.     MUIA_Icon_Name, name,
  116.  
  117.    FUNCTION
  118.  
  119.    INPUTS
  120.     name - name of the icon file without the .info extension.
  121.  
  122.    NOTES
  123.     If the icon contains both a render and select image then the
  124.     appropriate image will be displayed depending on the gadget
  125.     select state.  If the icon does not include a select image
  126.     then the gadget select image will be the same as the render
  127.     image.
  128.  
  129.    BUGS
  130.     No known bugs.
  131.  
  132.    SEE ALSO
  133.  
  134. Icon/MUIA_Icon_DefaultTool
  135.  
  136.    NAME
  137.     MUIA_Icon_DefaultTool [..G] -- ... (V1)
  138.  
  139.    SYNOPSIS
  140.     MUIA_Icon_DefaultTool,
  141.  
  142.    FUNCTION
  143.  
  144.    INPUTS
  145.     None
  146.  
  147.    RESULT
  148.     The icon default tool, if any, will be returned.  The return
  149.     value is a string pointer to the default tool name.
  150.  
  151.    NOTES
  152.     None
  153.  
  154.    BUGS
  155.     No known bugs.
  156.  
  157.    SEE ALSO
  158.  
  159.